GetMeanOfGridFloat Function

private function GetMeanOfGridFloat(grid, maskReal, maskInteger) result(mean)

compute mean of grid_real eventually constrained to a mask

Arguments

Type IntentOptional Attributes Name
type(grid_real), intent(in) :: grid
type(grid_real), intent(in), optional :: maskReal
type(grid_integer), intent(in), optional :: maskInteger

Return Value real(kind=float)


Variables

Type Visibility Attributes Name Initial
real(kind=float), public :: countCells
integer(kind=long), public :: i
integer(kind=long), public :: j

Source Code

FUNCTION GetMeanOfGridFloat &
!
(grid, maskReal, maskInteger) &
!
RESULT (mean)

IMPLICIT NONE

!Arguments with intent(in):
TYPE (grid_real), INTENT(IN) :: grid
TYPE (grid_real), OPTIONAL,  INTENT(IN) :: maskReal
TYPE (grid_integer), OPTIONAL,  INTENT(IN) :: maskInteger


!Local declarations:
REAL (KIND = float) :: mean
REAL (KIND = float) :: countCells
INTEGER (KIND = long) :: i, j
!---------------------------end of declarations--------------------------------
mean = 0.
countCells = 0.
!check that grid and mask have the same coordinate reference system
IF (PRESENT (maskReal)) THEN
    IF ( .NOT. CRSisEqual(maskReal,grid) ) THEN
        CALL Catch ('error', 'GridStatistics',  &
        'calculate mean: ', argument = &
        'coordinate reference system of mask differs from input grid' )
    END IF

    DO j = 1, maskReal % jdim
        DO i = 1, maskReal % idim
            IF (maskReal % mat(i,j) /= maskReal % nodata) THEN
                IF (grid % mat (i,j) /= grid % nodata) THEN
                   CALL Catch ('warning', 'GridStatistics',  &
                             'calculate mean: ', argument = &
                              'found nodata within mask' ) 
                   mean = mean + grid % mat (i,j)
                   countCells = countCells + 1.
                END IF
            END IF
        END DO
    END DO
ELSE IF (PRESENT (maskInteger)) THEN
    IF ( .NOT. CRSisEqual(maskInteger,grid) ) THEN
        CALL Catch ('error', 'GridStatistics',  &
        'calculate mean: ', argument = &
        'coordinate reference system of mask differs from input grid' )
    END IF

    DO j = 1, maskInteger % jdim
        DO i = 1, maskInteger % idim
            IF (maskInteger % mat(i,j) /= maskInteger % nodata) THEN
                 IF (grid % mat (i,j) /= grid % nodata) THEN
                     CALL Catch ('warning', 'GridStatistics',  &
                             'calculate mean: ', argument = &
                              'found nodata within mask' ) 
                     mean = mean + grid % mat (i,j)
                     countCells = countCells + 1
                 END IF
            END IF
        END DO
    END DO

ELSE
    DO j = 1, grid % jdim
        DO i = 1, grid % idim
            IF (grid % mat(i,j) /= grid % nodata) THEN
                mean = mean + grid % mat (i,j)
                countCells = countCells + 1.
            END IF
        END DO
    END DO
END IF

mean = mean / countCells

RETURN

END FUNCTION GetMeanOfGridFloat